<?xml version='1.0' encoding='iso-8859-1'?>
<!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
	<head>
		<title>
			plcotst.c
			</title>
		<meta http-equiv='content-type' content='text/html;iso-8859-1'/>
		<meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
		<meta name='author' content='cmaier@cmassoc.net'/>
		<meta name='robots' content='noindex,nofollow'/>
		<link href='toolkit.css' rel='stylesheet' type='text/css'/>
		</head>
	<body>
		<div class='headerlink'>
			[<a href='PLCNetworkInfo.c.html' title=' PLCNetworkInfo.c '>PREV</a>]
			[<a href='toolkit.html' title=' Index '>HOME</a>]
			[<a href='PLCPhyRates.c.html' title=' PLCPhyRates.c '>NEXT</a>]
			</div>
<pre>
/*====================================================================*
 *
 *   Copyright (c) 2013 Qualcomm Atheros, Inc.
 *
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or 
 *   without modification, are permitted (subject to the limitations 
 *   in the disclaimer below) provided that the following conditions 
 *   are met:
 *
 *   * Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above 
 *     copyright notice, this list of conditions and the following 
 *     disclaimer in the documentation and/or other materials 
 *     provided with the distribution.
 *
 *   * Neither the name of Qualcomm Atheros nor the names of 
 *     its contributors may be used to endorse or promote products 
 *     derived from this software without specific prior written 
 *     permission.
 *
 *   NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE 
 *   GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE 
 *   COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR 
 *   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 
 *   OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 *   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 *   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 *   OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  
 *
 *--------------------------------------------------------------------*/

/*====================================================================*
 *
 *   plcotst.c - Atheros PLC One-Time Self-Test Manager;
 *
 *   Use VS_SELFTEST_ONETIME_CONFIG and VS_SELFTEST_RESULTS message
 *   type to configure the Atheros PLC One-Time Self-Test then read
 *   and display stored selftest results;
 *
 *   Contributor(s):
 *      Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
 *
 *--------------------------------------------------------------------*/

/*====================================================================*&quot;
 *   system header files;
 *--------------------------------------------------------------------*/

#include &lt;unistd.h&gt;
#include &lt;stdlib.h&gt;
#include &lt;stdint.h&gt;
#include &lt;limits.h&gt;

/*====================================================================*
 *   custom header files;
 *--------------------------------------------------------------------*/

#include &quot;../tools/getoptv.h&quot;
#include &quot;../tools/putoptv.h&quot;
#include &quot;../tools/memory.h&quot;
#include &quot;../tools/number.h&quot;
#include &quot;../tools/symbol.h&quot;
#include &quot;../tools/types.h&quot;
#include &quot;../tools/flags.h&quot;
#include &quot;../tools/files.h&quot;
#include &quot;../tools/error.h&quot;
#include &quot;../plc/plc.h&quot;

/*====================================================================*
 *   custom source files;
 *--------------------------------------------------------------------*/

#ifndef MAKEFILE
#include &quot;../plc/Confirm.c&quot;
#include &quot;../plc/Display.c&quot;
#include &quot;../plc/Failure.c&quot;
#include &quot;../plc/Request.c&quot;
#include &quot;../plc/ReadMME.c&quot;
#include &quot;../plc/SendMME.c&quot;
#include &quot;../mme/UnwantedMessage.c&quot;
#include &quot;../plc/Devices.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../tools/getoptv.c&quot;
#include &quot;../tools/putoptv.c&quot;
#include &quot;../tools/version.c&quot;
#include &quot;../tools/uintspec.c&quot;
#include &quot;../tools/hexdump.c&quot;
#include &quot;../tools/hexencode.c&quot;
#include &quot;../tools/hexdecode.c&quot;
#include &quot;../tools/todigit.c&quot;
#include &quot;../tools/synonym.c&quot;
#include &quot;../tools/error.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../ether/openchannel.c&quot;
#include &quot;../ether/closechannel.c&quot;
#include &quot;../ether/readpacket.c&quot;
#include &quot;../ether/sendpacket.c&quot;
#include &quot;../ether/channel.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../mme/MMECode.c&quot;
#include &quot;../mme/EthernetHeader.c&quot;
#include &quot;../mme/QualcommHeader.c&quot;
#endif

/*====================================================================*
 *   program constants;
 *--------------------------------------------------------------------*/

#define PLCOTST_MVERSION 0
#define PLCOTST_RUNAFTERRESET 1
#define PLCOTST_DELAYTORUN 0
#define PLCOTST_MEMRUNS 0
#define PLCOTST_FLASHRUNS 0
#define PLCOTST_RESETONDONE 0

/*====================================================================*
 *   program variables;
 *--------------------------------------------------------------------*/

#ifndef __GNUC__
#pragma pack (push,1)
#endif

typedef struct __packed selftest

{
	uint8_t MVERSION;
	uint8_t RUNAFTERRESET;
	uint32_t DELAYTORUN;
	uint32_t MEMRUNS;
	uint32_t FLASHRUNS;
	uint8_t RESETONDONE;
}

selftest;

#ifndef __GNUC__
#pragma pack (pop)
#endif

/*====================================================================*
 *
 *   signed configure (struct plc * plc, struct selftest * selftest);
 *
 *
 *--------------------------------------------------------------------*/

static signed configure (struct plc * plc, struct selftest * selftest)

{
	struct channel * channel = (struct channel *)(plc-&gt;channel);
	struct message * message = (struct message *)(plc-&gt;message);

#ifndef __GNUC__
#pragma pack (push,1)
#endif

	struct __packed vs_selftest_onetime_config_request
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint8_t MVERSION;
		uint8_t RUNAFTERRESET;
		uint32_t DELAYTORUN;
		uint32_t MEMRUNS;
		uint32_t FLASHRUNS;
		uint8_t RESETONDONE;
	}
	* request = (struct vs_selftest_onetime_config_request *) (message);
	struct __packed vs_selftest_onetime_config_confirm
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint8_t MSTATUS;
	}
	* confirm = (struct vs_selftest_onetime_config_confirm *) (message);

#ifndef __GNUC__
#pragma pack (pop)
#endif

	Request (plc, &quot;Configure One-Time Self-Test&quot;);
	memset (message, 0, sizeof (* message));
	EthernetHeader (&amp;request-&gt;ethernet, channel-&gt;peer, channel-&gt;host, channel-&gt;type);
	QualcommHeader (&amp;request-&gt;qualcomm, 0, (VS_SELFTEST_ONETIME_CONFIG | MMTYPE_REQ));
	request-&gt;MVERSION = selftest-&gt;MVERSION;
	request-&gt;RUNAFTERRESET = selftest-&gt;RUNAFTERRESET;
	request-&gt;DELAYTORUN = HTOLE32 (selftest-&gt;DELAYTORUN);
	request-&gt;MEMRUNS = HTOLE32 (selftest-&gt;MEMRUNS);
	request-&gt;FLASHRUNS = HTOLE32 (selftest-&gt;FLASHRUNS);
	request-&gt;RESETONDONE = selftest-&gt;RESETONDONE;
	plc-&gt;packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
	if (SendMME (plc) &lt;= 0)
	{
		error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
		return (-1);
	}
	while (ReadMME (plc, 0, (VS_SELFTEST_ONETIME_CONFIG | MMTYPE_CNF)) &gt; 0)
	{
		if (confirm-&gt;MSTATUS)
		{
			Failure (plc, PLC_WONTDOIT);
			continue;
		}
		Display (plc, &quot;%s&quot;, &quot;Configured&quot;);
	}
	return (0);
}

/*====================================================================*
 *
 *   signed retrieve (struct plc * plc, struct selftest * selftest);
 *
 *
 *--------------------------------------------------------------------*/

static signed retrieve (struct plc * plc, struct selftest * selftest)

{
	struct channel * channel = (struct channel *)(plc-&gt;channel);
	struct message * message = (struct message *)(plc-&gt;message);

#ifndef __GNUC__
#pragma pack (push,1)
#endif

	struct __packed vs_selftest_results_request
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint8_t MVERSION;
		uint8_t MACTION;
	}
	* request = (struct vs_selftest_results_request *) (message);
	struct __packed vs_selftest_results_confirm
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint8_t MVERSION;
		uint8_t MSTATUS;
		uint32_t NUMBER [6];
	}
	* confirm = (struct vs_selftest_results_confirm *) (message);

#ifndef __GNUC__
#pragma pack (pop)
#endif

	Request (plc, &quot;Retrieve Self-Test Results&quot;);
	memset (message, 0, sizeof (* message));
	EthernetHeader (&amp;request-&gt;ethernet, channel-&gt;peer, channel-&gt;host, channel-&gt;type);
	QualcommHeader (&amp;request-&gt;qualcomm, 0, (VS_SELFTEST_RESULTS | MMTYPE_REQ));
	request-&gt;MVERSION = selftest-&gt;MVERSION;
	request-&gt;MACTION = plc-&gt;action;
	plc-&gt;packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
	if (SendMME (plc) &lt;= 0)
	{
		error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
		return (-1);
	}
	while (ReadMME (plc, 0, (VS_SELFTEST_RESULTS | MMTYPE_CNF)) &gt; 0)
	{
		if ((confirm-&gt;MSTATUS == 2) || (confirm-&gt;MSTATUS == 4) || (confirm-&gt;MSTATUS == 6))
		{
			Display (plc, &quot;Memory test %d Passed %d Failed %d  Flash test %d Passed %d Failed %d&quot;, LE32TOH (confirm-&gt;NUMBER [0]), LE32TOH (confirm-&gt;NUMBER [1]), LE32TOH (confirm-&gt;NUMBER [2]), LE32TOH (confirm-&gt;NUMBER [3]), LE32TOH (confirm-&gt;NUMBER [4]), LE32TOH (confirm-&gt;NUMBER [5]));
			continue;
		}
		if (confirm-&gt;MSTATUS == 3)
		{
			Failure (plc, &quot;%d seconds remaining&quot;, LE32TOH (confirm-&gt;NUMBER [0]));
			continue;
		}
		if (confirm-&gt;MSTATUS)
		{
			Failure (plc, PLC_WONTDOIT);
			continue;
		}
		Confirm (plc, &quot;Cleared Results&quot;);
	}
	return (0);
}

/*====================================================================*
 *
 *   signed manager (struct plc * plc, struct selftest * selftest);
 *
 *
 *--------------------------------------------------------------------*/

static signed manager (struct plc * plc, struct selftest * selftest)

{
	if (_anyset (plc-&gt;flags, PLC_CONFIGURE))
	{
		configure (plc, selftest);
	}
	if (_anyset (plc-&gt;flags, PLC_RESULTS))
	{
		retrieve (plc, selftest);
	}
	return (0);
}

/*====================================================================*
 *
 *   int main (int argc, char const * argv[]);
 *
 *
 *--------------------------------------------------------------------*/

int main (int argc, char const * argv [])

{
	extern struct channel channel;
	static char const * optv [] =
	{
		&quot;c:Cd:ef:i:m:qr:R:t:vx&quot;,
		&quot;device [device] [...] [&gt; stdout]&quot;,
		&quot;Qualcomm Atheros Powerline One-Time Self-Test Manager&quot;,
		&quot;c n\tconfiguration version&quot;,
		&quot;C\tclear selftest results&quot;,
		&quot;d n\tdelay selftest start by (n) seconds [&quot; LITERAL (PLCOTST_DELAYTORUN) &quot;]&quot;,
		&quot;e\tredirect stderr to stdout&quot;,
		&quot;f n\trun flash selftest (n) times [&quot; LITERAL (PLCOTST_FLASHRUNS) &quot;]&quot;,

#if defined (WINPCAP) || defined (LIBPCAP)

		&quot;i n\thost interface is (n) [&quot; LITERAL (CHANNEL_ETHNUMBER) &quot;]&quot;,

#else

		&quot;i s\thost interface is (s) [&quot; LITERAL (CHANNEL_ETHDEVICE) &quot;]&quot;,

#endif

		&quot;m n\trun memory selftest (n) times [&quot; LITERAL (PLCOTST_MEMRUNS) &quot;]&quot;,
		&quot;q\tquiet mode&quot;,
		&quot;r n\trun selftest after reset [&quot; LITERAL (PLCOTST_RUNAFTERRESET) &quot;]&quot;,
		&quot;R n\treset after selftest completes [&quot; LITERAL (PLCOTST_RESETONDONE) &quot;]&quot;,
		&quot;t n\tread timeout is (n) milliseconds [&quot; LITERAL (CHANNEL_TIMEOUT) &quot;]&quot;,
		&quot;v\tverbose mode&quot;,
		&quot;x\texit on error&quot;,
		(char const *) (0)
	};

#include &quot;../plc/plc.c&quot;

	struct selftest selftest =
	{
		PLCOTST_MVERSION,
		PLCOTST_RUNAFTERRESET,
		PLCOTST_DELAYTORUN,
		PLCOTST_MEMRUNS,
		PLCOTST_FLASHRUNS,
		PLCOTST_RESETONDONE
	};
	signed c;
	if (getenv (PLCDEVICE))
	{
		channel.ifname = strdup (getenv (PLCDEVICE));
	}
	optind = 1;
	while ((c = getoptv (argc, argv, optv)) != -1)
	{
		switch (c)
		{
		case 'c':
			selftest.MVERSION = (uint8_t)(uintspec (optarg, 0, UCHAR_MAX));
			break;
		case 'C':
			_setbits (plc.flags, PLC_RESULTS);
			plc.action = 1;
			break;
		case 'd':
			_setbits (plc.flags, PLC_CONFIGURE);
			selftest.DELAYTORUN = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
			break;
		case 'e':
			dup2 (STDOUT_FILENO, STDERR_FILENO);
			break;
		case 'f':
			_setbits (plc.flags, PLC_CONFIGURE);
			selftest.FLASHRUNS = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
			break;
		case 'i':

#if defined (WINPCAP) || defined (LIBPCAP)

			channel.ifindex = atoi (optarg);

#else

			channel.ifname = optarg;

#endif

			break;
		case 'm':
			_setbits (plc.flags, PLC_CONFIGURE);
			selftest.MEMRUNS = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
			break;
		case 'q':
			_setbits (channel.flags, CHANNEL_SILENCE);
			_setbits (plc.flags, PLC_SILENCE);
			break;
		case 'r':
			_setbits (plc.flags, PLC_CONFIGURE);
			selftest.RUNAFTERRESET = (uint8_t)(uintspec (optarg, false, true));
			break;
		case 'R':
			_setbits (plc.flags, PLC_CONFIGURE);
			selftest.RESETONDONE = (uint8_t)(uintspec (optarg, false, true));
			break;
		case 't':
			channel.timeout = (signed)(uintspec (optarg, 0, UINT_MAX));
			break;
		case 'v':
			_setbits (channel.flags, CHANNEL_VERBOSE);
			_setbits (plc.flags, PLC_VERBOSE);
			break;
		case 'x':
			_setbits (plc.flags, PLC_BAILOUT);
			break;
		default:
			break;
		}
	}
	argc -= optind;
	argv += optind;
	if (_allclr (plc.flags, (PLC_CONFIGURE | PLC_RESULTS)))
	{
		_setbits (plc.flags, PLC_RESULTS);
	}
	openchannel (&amp;channel);
	if (!(plc.message = malloc (sizeof (* plc.message))))
	{
		error (1, errno, PLC_NOMEMORY);
	}
	if (!argc)
	{
		manager (&amp;plc, &amp;selftest);
	}
	while ((argc) &amp;&amp; (* argv))
	{
		if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
		{
			error (1, errno, PLC_BAD_MAC, * argv);
		}
		manager (&amp;plc, &amp;selftest);
		argv++;
		argc--;
	}
	free (plc.message);
	closechannel (&amp;channel);
	return (0);
}


</pre>
		<div class='footerlink'>
			[<a href='PLCNetworkInfo.c.html' title=' PLCNetworkInfo.c '>PREV</a>]
			[<a href='toolkit.html' title=' Index '>HOME</a>]
			[<a href='PLCPhyRates.c.html' title=' PLCPhyRates.c '>NEXT</a>]
			</div>
		</body>
	</html>
